DOC-1569 Console new config for audit-logs #1346

micheleRP · 2025-08-29T03:15:31Z

Description

This pull request adds how to enable audit logging in Redpanda Console. The changes add examples of the auditLog.enabled configuration:

Added auditLog.enabled: false to YAML configuration examples in modules/console/pages/config/configure-console.adoc and modules/shared/attachments/redpanda-console-config.yaml to demonstrate how to enable audit logging in Redpanda Console. [1] [2] [3]
Added auditlog.enabled: false under the kafka section in a YAML example to show audit logging configuration for Kafka brokers.
Added a note in modules/manage/partials/audit-logging.adoc explaining that users can view audit events in Redpanda Console by enabling audit logging with auditLog.enabled: true, with reference to the configuration documentation.

Resolves https://redpandadata.atlassian.net/browse/DOC-1569
Review deadline:

Page previews

Configure Redpanda Console
Audit Loggings (conditionalized out for Cloud)

Checks

New feature
Content gap
Support Follow-up
Small fix (typos, links, copyedits, etc)

netlify · 2025-08-29T03:15:37Z

✅ Deploy Preview for redpanda-docs-preview ready!

Name	Link
🔨 Latest commit	`6c69301`
🔍 Latest deploy log	https://app.netlify.com/projects/redpanda-docs-preview/deploys/68b207fd519be00008a6830f
😎 Deploy Preview	https://deploy-preview-1346--redpanda-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

coderabbitai · 2025-08-29T03:15:39Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

Adds documentation and sample configuration for a new Console audit log UI toggle. Updates include: introducing console.auditLog.enabled (default false) in the shared YAML attachment and in the Console configuration page examples; adding a note in the audit logging docs (non-cloud) describing how to view audit events by enabling the toggle; minor casing and formatting adjustments in docs.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Console: New configuration for audit logs (DOC-1569)	✅

Assessment against linked issues: Out-of-scope changes

Code Change	Explanation
Header casing change in env var table from “Environment Variable” to “Environment variable” (modules/console/pages/config/configure-console.adoc)	This is cosmetic and not tied to the audit log configuration objective.
Formatting adjustments to sample YAML include block (modules/console/pages/config/configure-console.adoc)	Formatting-only change; not required by the audit log configuration objective.

Suggested reviewers

weeco
r-vasquez
mattschumpert

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch DOC-1569-Console-New-configuration-for-audit-logs

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

Visit our Status Page to check the current availability of CodeRabbit.
Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 3

🧹 Nitpick comments (1)

modules/console/pages/config/configure-console.adoc (1)

25-32: Optional: add env var mapping for the new key.

Consider adding console.auditLog.enabled → CONSOLE_AUDITLOG_ENABLED to the mapping table to improve discoverability.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

MCP integration is disabled by default for public repositories
Jira integration is disabled by default for public repositories
Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 0bf9d82 and 60e1dae.

📒 Files selected for processing (3)

modules/console/pages/config/configure-console.adoc (5 hunks)
modules/manage/partials/audit-logging.adoc (1 hunks)
modules/shared/attachments/redpanda-console-config.yaml (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

GitHub Check: run-tests (ubuntu-latest)
GitHub Check: Redirect rules - redpanda-docs-preview
GitHub Check: Header rules - redpanda-docs-preview
GitHub Check: Pages changed - redpanda-docs-preview

🔇 Additional comments (3)

modules/manage/partials/audit-logging.adoc (1)

19-20: Good addition; link and key look correct.

References console.auditLog.enabled: true and links to the right page. No issues.

modules/shared/attachments/redpanda-console-config.yaml (1)

274-276: LGTM; correct placement and casing.

console.auditLog.enabled: false is under the console: block with the right casing and a clear comment.

modules/console/pages/config/configure-console.adoc (1)

214-215: Formatting fence count.

Double-check the closing fence count around the include; ensure it matches the opening fence to avoid rendering glitches.

modules/console/pages/config/configure-console.adoc

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

modules/console/pages/config/configure-console.adoc

modules/manage/partials/audit-logging.adoc

Co-authored-by: Martin Schneppenheim <[email protected]>

Feediver1

lgtm

weeco · 2025-08-29T20:01:30Z

modules/console/pages/config/configure-console.adoc

          brokers: ["redpanda-0:9092","redpanda-1:9092","redpanda-2:9092"]
+        auditLog:
+          enabled: false   # default; set to true to write audit logs to stdout
+          additionalHeaders: # specifies HTTP headers to include in audit logs


Needs an example otherwise it's unclear how to use

Also it defaults to: ["X-Forwarded-For", "User-Agent"]

please check me!

DOC-1569 Console new config for audit-logs

e506488

micheleRP added 4 commits August 28, 2025 21:15

default to false

db97200

edit

f61fb1b

minor edit

2ec5c78

minor edit

60e1dae

micheleRP requested a review from weeco August 29, 2025 04:04

micheleRP marked this pull request as ready for review August 29, 2025 04:05

micheleRP requested a review from a team as a code owner August 29, 2025 04:05

coderabbitai bot reviewed Aug 29, 2025

View reviewed changes

modules/console/pages/config/configure-console.adoc Show resolved Hide resolved

modules/console/pages/config/configure-console.adoc Show resolved Hide resolved

modules/console/pages/config/configure-console.adoc Show resolved Hide resolved

micheleRP and others added 3 commits August 28, 2025 22:19

Update modules/console/pages/config/configure-console.adoc

18fba6c

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Update modules/console/pages/config/configure-console.adoc

1dc708a

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Update modules/console/pages/config/configure-console.adoc

9545b5b

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

weeco requested changes Aug 29, 2025

View reviewed changes

micheleRP and others added 3 commits August 29, 2025 07:51

Update modules/console/pages/config/configure-console.adoc

31d87d7

Co-authored-by: Martin Schneppenheim <[email protected]>

incorporate feedback

a9d3d51

add to k8s stsandalone

e48e358

micheleRP requested a review from weeco August 29, 2025 15:17

weeco approved these changes Aug 29, 2025

View reviewed changes

Feediver1 approved these changes Aug 29, 2025

View reviewed changes

Add additionalHeaders

192ccc1

weeco reviewed Aug 29, 2025

View reviewed changes

add X-Forwarded-For, User-Agent

6c69301

weeco approved these changes Sep 1, 2025

View reviewed changes

micheleRP merged commit c4f7d8f into main Sep 1, 2025
7 checks passed

micheleRP deleted the DOC-1569-Console-New-configuration-for-audit-logs branch September 1, 2025 15:04

DOC-1569 Console new config for audit-logs #1346

DOC-1569 Console new config for audit-logs #1346

Uh oh!

Conversation

micheleRP commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Page previews

Checks

Uh oh!

netlify bot commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for redpanda-docs-preview ready!

Uh oh!

coderabbitai bot commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Estimated code review effort

Assessment against linked issues

Assessment against linked issues: Out-of-scope changes

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Status, Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Feediver1 left a comment

Choose a reason for hiding this comment

Uh oh!

weeco Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

weeco Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

micheleRP Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

micheleRP commented Aug 29, 2025 •

edited

Loading

netlify bot commented Aug 29, 2025 •

edited

Loading

coderabbitai bot commented Aug 29, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)